/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.manager;

import com.genia.toolbox.uml_generator.model.AbstractObject;

/**
 * Utility class to handle the different {@link String} that must be generated
 * from an object name.
 */
public interface NameManager
{

  /**
   * return the name of an {@link AbstractObject} with its first letter in upper
   * case.
   * 
   * @param object
   *          the {@link AbstractObject} to consider
   * @return the name of the {@link AbstractObject} with its first letter in
   *         upper case
   */
  public String getUpperCaseFirstLetterName(AbstractObject object);



  /**
   * return the name of an {@link AbstractObject} with its first letter in lower
   * case.
   * 
   * @param object
   *          the {@link AbstractObject} to consider
   * @return the name of the {@link AbstractObject} with its first letter in
   *         lower case
   */
  public String getLowerCaseFirstLetterName(AbstractObject object);



  /**
   * return the name of an {@link AbstractObject} with an underscore to separate
   * words.
   * 
   * @param object
   *          the {@link AbstractObject} to consider
   * @return the name of the {@link AbstractObject} with an underscore to
   *         separate words
   */
  public String getUnderlineName(AbstractObject object);



  /**
   * return the upper case name of an {@link AbstractObject} with an underscore
   * to separate words.
   * 
   * @param object
   *          the {@link AbstractObject} to consider
   * @return the upper case name of the {@link AbstractObject} with an
   *         underscore to separate words
   */
  public String getUpperUnderlineName(AbstractObject object);



  /**
   * return the lower case name of an {@link AbstractObject} with an underscore
   * to separate words.
   * 
   * @param object
   *          the {@link AbstractObject} to consider
   * @return the lower case name of the {@link AbstractObject} with an
   *         underscore to separate words
   */
  public String getLowerUnderlineName(AbstractObject object);
}
